Api.GetStatusEx method

Gets the extended state of an EtherCAT link. Use this function to see when the link has been established. After the link is established you can access the number of I/O and servo modules.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsError GetStatusEx(
       SubsystemStatusEx Status,
       SubsystemDiagnostics Diagnostics
)

Public Function GetStatusEx(
       Status As SubsystemStatusEx,
       Diagnostics As SubsystemDiagnostics
) As KsError

Parameters

Status

Type: SubsystemStatusEx

Shows the state of the EtherCAT link.

Diagnostics

Type: SubsystemDiagnostics

Shows the diagnostics information of EtherCAT slaves' state.

Return value

Type: KsError

A return code of a method.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A